Add note to differentiate btw TextDoc & TextEditor #41307
Merged
+12
−0
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jrieken
requested changes
Jan 8, 2018
src/vs/vscode.d.ts
Outdated
| */ | ||
| export const onDidOpenTextDocument: Event<TextDocument>; | ||
|
|
||
| /** | ||
| * An event that is emitted when a [text document](#TextDocument) is disposed. | ||
| * | ||
| * To add an event listener when a visible text document is closed, use the [TextEditor](#TextEditor) events in the | ||
| * [window](#_window) namespace. Note that this event is not emitted when a [text document]#TextDocument is closed |
There was a problem hiding this comment.
[text document]#TextDocument that's actually a markup issue. Also, it should better be 'text editor' because that's what users 'visually close' (pressing the X).
There was a problem hiding this comment.
Changed it to:
not emitted when a [TextEditor](#TextEditor) is closed and the document remains open
|
lgtm. thanks |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
These are some of the things I wish I had known before using the TextDocument event listeners.
cc @jrieken, #40653